Skip to content

feat(python): Add enumUnknownDefaultCase support for backward compatibility #22037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(python): Add enumUnknownDefaultCase support for backward compatibility #22037

wants to merge 3 commits into from
+190 −0

Conversation

ranjanp75
Copy link

@ranjanp75 ranjanp75 commented Sep 27, 2025 •
edited
Loading

This PR adds support for the enumUnknownDefaultCase option to the Python generator, enabling graceful handling of unknown enum values. This feature improves backward compatibility when servers introduce new enum values that older clients don't recognize.

Fixes #20012

Usage:
--additional-properties enumUnknownDefaultCase=true

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328 @spacether @cbornet @tomplus @krjakbrjak @fa0311 @multani

@ranjanp75
Copy link
Author

@wing328 @spacether @cbornet @tomplus @krjakbrjak @fa0311 @multani Please review. Thanks

@wing328
Copy link
Member

wing328 commented Sep 28, 2025

please review the build failure when you've time:

Error:  org.openapitools.codegen.python.PythonClientCodegenTest.testEnumModelWithUnknownDefaultCase -- Time elapsed: 0.004 s <<< ERROR!
java.lang.NullPointerException
	at org.openapitools.codegen.utils.ModelUtils.getOpenApiVersion(ModelUtils.java:2034)
	at org.openapitools.codegen.TestUtils.parseSpec(TestUtils.java:66)
	at org.openapitools.codegen.TestUtils.parseFlattenSpec(TestUtils.java:45)
	at org.openapitools.codegen.python.PythonClientCodegenTest.testEnumModelWithUnknownDefaultCase(PythonClientCodegenTest.java:710)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.testng.internal.invokers.MethodInvocationHelper.invokeMethod(MethodInvocationHelper.java:141)
	at org.testng.internal.invokers.TestInvoker.invokeMethod(TestInvoker.java:686)
	at org.testng.internal.invokers.TestInvoker.invokeTestMethod(TestInvoker.java:230)
	at org.testng.internal.invokers.MethodRunner.runInSequence(MethodRunner.java:63)
	at org.testng.internal.invokers.TestInvoker$MethodInvocationAgent.invoke(TestInvoker.java:992)
	at org.testng.internal.invokers.TestInvoker.invokeTestMethods(TestInvoker.java:203)
	at org.testng.internal.invokers.TestMethodWorker.invokeTestMethods(TestMethodWorker.java:154)
	at org.testng.internal.invokers.TestMethodWorker.run(TestMethodWorker.java:134)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1541)
	at org.testng.TestRunner.privateRun(TestRunner.java:739)
	at org.testng.TestRunner.run(TestRunner.java:614)
	at org.testng.SuiteRunner.runTest(SuiteRunner.java:421)
	at org.testng.SuiteRunner.runSequentially(SuiteRunner.java:413)
	at org.testng.SuiteRunner.privateRun(SuiteRunner.java:373)
	at org.testng.SuiteRunner.run(SuiteRunner.java:312)
	at org.testng.SuiteRunnerWorker.runSuite(SuiteRunnerWorker.java:52)
	at org.testng.SuiteRunnerWorker.run(SuiteRunnerWorker.java:95)
	at org.testng.TestNG.runSuitesSequentially(TestNG.java:1274)
	at org.testng.TestNG.runSuitesLocally(TestNG.java:1208)
	at org.testng.TestNG.runSuites(TestNG.java:1112)
	at org.testng.TestNG.run(TestNG.java:1079)

Error:  Errors: 
Error:  org.openapitools.codegen.python.PythonClientCodegenTest.testEnumGenerationWithUnknownDefaultCase
Error:    Run 1: PythonClientCodegenTest.testEnumGenerationWithUnknownDefaultCase:771 » NullPointer
Error:    Run 2: PythonClientCodegenTest.testEnumGenerationWithUnknownDefaultCase:771 » NullPointer
Error:    Run 3: PythonClientCodegenTest.testEnumGenerationWithUnknownDefaultCase:771 » NullPointer
Error:  org.openapitools.codegen.python.PythonClientCodegenTest.testEnumGenerationWithoutUnknownDefaultCase
Error:    Run 1: PythonClientCodegenTest.testEnumGenerationWithoutUnknownDefaultCase:798 » NullPointer
Error:    Run 2: PythonClientCodegenTest.testEnumGenerationWithoutUnknownDefaultCase:798 » NullPointer
Error:    Run 3: PythonClientCodegenTest.testEnumGenerationWithoutUnknownDefaultCase:798 » NullPointer
Error:  org.openapitools.codegen.python.PythonClientCodegenTest.testEnumModelWithUnknownDefaultCase

@ranjanp75
Copy link
Author

@wing328 I have fixed the tests, Please re-trigger the builds. Thanks

@wing328
Copy link
Member

wing328 commented Sep 30, 2025

i enabled the option in one of the samples but the test failed:

#22048

can you please review?

@wing328 wing328 mentioned this pull request Sep 30, 2025
Draft
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[REQ] Add Support for enumUnknownDefaultCase in Python Generator
3 participants
@ranjanp75 @wing328 @ranjanprasad1996